Davar4: MDK - Preparation of book modules Homepage Help index Previous Next

 
 

Preparation of book modules


Book modules are modules, which have structure similar to Bible, i.e. division to book-chapter-verse.

For simple texts (without tags), it is relatively easy to prepare input data.txt file from different sources. You can use, for example text from online internet Bibles or exports from various biblical programs.

 

IMPORTANT RULES:

1) data.txt file contains one verse per line. Each line is finished by Enter (CR+LF characters)

2) There cannot be missing verses or chapters

 

If you need to insert new paragraph into verse, use |C tag

If your text has missing verse, use some neutral text e.g. "---" and fill correctly reference.

 


data.txt file

 

Example of data.txt file:

; this is note
Ge 1:1 In the beginning God created the heaven and the earth.
Ge 1:2 And the earth|RH776|Rh was|RH1961|Rh|RH8804|Rh without form|RH8414|Rh, and void|RH922|Rh; and darkness|RH2822|Rh |TUwas|Tu upon the face|RH6440|Rh of the deep|RH8415|Rh. And the Spirit|RH7307|Rh of God|RH430|Rh moved|RH7363|Rh|RH8764|Rh upon|RH5921|Rh the face|RH6440|Rh of the waters|RH4325|Rh.
Ge 1:3 ---
Ge 1:4 And God|RH430|Rh saw|RH7200|Rh|RH8799|Rh|RH853|Rh the light|RH216|Rh, that|RH3588|Rh |TUit was|Tu good|RH2896|Rh: and God|RH430|Rh divided|RH914|Rh|RH8686|Rh|RH996|Rh the light|RH216|Rh from|RH996|Rh the darkness|RH2822|Rh.|TVthe light from…: Heb. between the light and between the darkness|Tv

 

; this is note = note, text is ignored if FIRST character is ;

Ge 1:1 = text without tags

Ge 1:2 = text with Hebrew Strong# tags, which are immediately after particular word. E.g. earth|RH776|Rh which means earth has H776. Also used tag for unused word in original |TUwas|Tu

Ge 1:3 = example of missing verse (in original text) and because Davar cannot process missing verses, it has text "---"

Ge 1:4 = example of text with variant |TVthe light from…: Heb. between the light and between the darkness|Tv

 

IMPORTANT:

1) Names of the books (Ge) are not important for conversion. You can use instead of "Ge" for Genesis also "1" or "ABC" or "Genesis" or "1Moses" or something else - which makes conversion easier. Names of the books, which are included into module are listed in info.txt in section D4_Books= (see below).

 

2) Conversion program search for pattern some_book_name chapter_number:verse_number text of verse

where important is part chapter_number:verse_number - for detection of reference

and SPACE text of verse finished by new paragraph (CR+LF, this means each verse is finished by Enter)

Last verse of the file is also finished by at least one new paragraph (CR+LF)

 

3) New book is detected whenever number of chapter and verse is 1. E.g.: Ex 1:1 These are the names of the sons of Israel... is detected as new book because chapter and verse=1.

 

info.txt file

 

Example of info.txt file used for KJV+ conversion (blue, bold) , next line (red) is commentary and explanation (not a part of file!). All red commentaries also starts here by ; character - thus you can copy and paste to editor all section below and use it as template for your module.

;THIS FILE MUST BE UTF-8, Little Endian, without Byte Order Mark. New line is CR+LF pair

; when ; is used as first character, all line is ignored (user note)

D4_OutputFile=kjv+.dbk

; name of the final output module file, kjv+.dbk

D4_Version_Major=1
D4_Version_Minor=1

; major and minor version. Important when you release fixed module versions

D4_Abbreviation=KJV+
; each module has abbreviation, be sure you use UNIQUE text. Max. 15 characters.

D4_Title=King James Version Bible
; short name of the module. Max 31 characters.

D4_Info=King James Version Bible 1611/1768. Include Strongs references and colored Jesus words
; Description of the module. When need to insert paragraph, use |C tag. Max. 8191 characters.

D4_Copyright=Public domain text
; Copyright info about the module. When need to insert paragraph, use |C tag. Max. 4095 characters.

D4_URL=
; URL where user can get info about module or next versions. Max. 255 characters.

 

D4_BooksNumber=66
; number of the books in module. For complete Bible it is 66.

D4_BooksExternNumber=0
; number of the EXTERNAL books in module. For example, you have NT module with 27 books, but it contains also OT references. In this case, you have 39 OT books, which are not part of module, but need info about them too. In this case, you will use them as external books and will use 39.

;0=latin book, 1=HE, 2=GR
D4_BookType=0

; as note line describes, it is language of the book. All LeftToRight books are considered as Latin (=0), Hebrew =1, Greek = 2 and books which are not Hebrew but has R2L direction = 3


D4_Tags=1

; if books is only plain text without tags, then use value =0. In cases when at least one tag is used in text, use value =1.

;Here are standard Microsoft values for primary and secondary language of the book
;hexadecimal values are expected. Look to README.TXT file for list.
;most frequent values for primary language:
;0x09 LANG_ENGLISH, 0x00 LANG_NEUTRAL, 0x05 LANG_CZECH, 0x0d LANG_HEBREW, 0x08 LANG_GREEK
D4_BookPrimaryLanguage=0x09
D4_BookSubLanguage=0x00

; for sorting of texts, program needs to know MAIN language of the book. Here are standard Microsoft values for languages in hexadecimal form. You will find complete list in D4-specification.txt file in MDK in section Identifier Predefined symbol Language. Some most common values are listed in note. If language of the book has no sublanguage, then use on second line: D4_BookSubLanguage=0x00

 

;Tag flags: 0=tag not used,1=tag is used and default visible,3=tag is used and default invisible |
D4_Tag_Preface=0
D4_Tag_Christ=1
D4_Tag_Notes=1
D4_Tag_Variant=1
D4_Tag_Unused=1
D4_Tag_Reference=0
D4_Tag_StrongsHE=1
D4_Tag_StrongsGR=1
D4_Tag_Bold=0
D4_Tag_Italic=1
D4_Tag_MorphologyHE=0
D4_Tag_MorphologyGR=0

;Type of GR morphology:0=none,1=Tauber,2=Robinson,3=Packard
D4_TypeOfGRMorphology=0;
D4_Tag_Qere=0
D4_Tag_Ketiv=0
D4_Tag_PDF=0
D4_Tag_URL=0

; list of all tags, used in Davar4. Use only values 0 or 1 (rest is not implemented yet). 1= tag is used, 0= tag is not used.

 

D4_Synchronize=1
; if book will be synchronized with other books when is opened. Default =1, recommended.

D4_ScrollVerses=1
; must have value = 1

D4_JumpInside=1
; if book contains references, setting to 1 means, that double click to this reference will jump in this module to position according reference. Setting to 0 means that ALL OTHER modules will be synchronized (if allowed), but position in this module will be unchanged.

 

D4_Books=
1,OTGen,Genesis,Gen
2,OTExod,Exodus,Exo
3,OTLev,Leviticus,Lev
4,OTNum,Numbers,Num
5,OTDeut,Deuteronomy,Deu
6,OTJosh,Joshua,Jos
7,OTJudg,Judges,Jdg
8,OTRuth,Ruth,Rth
9,OT1Sam,1 Samuel,1Sa
10,OT2Sam,2 Samuel,2Sa
11,OT1Kgs,1 Kings,1Ki
12,OT2Kgs,2 Kings,2Ki
13,OT1Chr,1 Chronicles,1Ch
14,OT2Chr,2 Chronicles,2Ch
15,OTEzra,Ezra,Ezr
16,OTNeh,Nehemiah,Neh
17,OTEsth,Esther,Est
18,OTJob,Job,Job
19,OTPss,Psalms,Psa
20,OTProv,Proverbs,Pro
21,OTQoh,Ecclesiastes,Ecc
22,OTCant,Song of Songs,Son
23,OTIsa,Isaiah,Isa
24,OTJer,Jeremiah,Jer
25,OTLam,Lamentations,Lam
26,OTEzek,Ezekiel,Eze
27,OTDan,Daniel,Dan
28,OTHos,Hosea,Hos
29,OTJoel,Joel,Joe
30,OTAmos,Amos,Amo
31,OTObad,Obadiah,Oba
32,OTJonah,Jonah,Jon
33,OTMic,Micah,Mic
34,OTNahum,Nahum,Nah
35,OTHab,Habakkuk,Hab
36,OTZeph,Zephaniah,Zep
37,OTHag,Haggai,Hag
38,OTZech,Zechariah,Zec
39,OTMal,Malachi,Mal
40,NTMatt,Matthew,Mat
41,NTMark,Mark,Mar
42,NTLuke,Luke,Luk
43,NTJohn,John,Joh
44,NTActs,Acts,Act
45,NTRoma,Romans,Rom
46,NT1Cor,1 Corinthians,1Co
47,NT2Cor,2 Corinthians,2Co
48,NTGalat,Galatians,Gal
49,NTEphes,Ephesians,Eph
50,NTPhili,Philippians,Phi
51,NTColos,Colossians,Col
52,NT1Thes,1 Thessalonians,1Th
53,NT2Thes,2 Thessalonians,2Th
54,NT1Tim,1 Timothy,1Ti
55,NT2Tim,2 Timothy,2Ti
56,NTTitus,Titus,Tit
57,NTPhile,Philemon,Phm
58,NTHebre,Hebrews,Heb
59,NTJames,James,Jam
60,NT1Pet,1 Peter,1Pe
61,NT2Pet,2 Peter,2Pe
62,NT1John,1 John,1Jo
63,NT2John,2 John,2Jo
64,NT3John,3 John,3Jo
65,NTJude,Jude,Jud
66,NTRevel,Revelation,Rev

 

; very important section. This block contains information about all books, which text is a part of module. First line:

;D4_Books=

;is immediately followed by descriptions for each book per line. Number of the lines MUST BE EXACTLY SAME AS THE NUMBER OF THE BOOKS specified before (section D4_Books=).

;Each book on line has following parameters (e.g. 1,OTGen,Genesis,Gen):

;1 =number of the book. From 1 to D4_Books

;OTGen = unique synchronization string for this book (Genesis). You will find complete list in D4-specification.txt file in MDK in section Reserved synchro names.

;Genesis = name of the book, which will be included in module. It means, you can use in data.txt almost any names for books, but this name will be used.

;Gen = abbreviation of the book, which will be used in module.

 

;If extern books are used, it is in format:
;D4_BooksExtern=
;1,OTGen,Genesis,Gn
;...etc

; if external books are used (see above), you can enable this section. It is identical as D4_Books= except first line, where is: D4_BooksExtern=

;Note, extern books are also numbered from 1.